home *** CD-ROM | disk | FTP | other *** search
/ Technotools / Technotools (Chestnut CD-ROM)(1993).ISO / lang_oth / forchek1 / readme < prev    next >
Text File  |  1991-10-28  |  5KB  |  137 lines
  1.                README file for Forchek Version 2.4
  2.  
  3. Author: Robert Moniot
  4. `Fordham University
  5. `New York, NY  USA
  6. `Bitnet:    MONIOT@FORDMULC
  7. `Internet:  moniot@mary.fordham.edu
  8.  
  9. Date:`August 1991
  10.  
  11. Forchek is written in a portable style of C.  You must have a C
  12. compiler for the machine on which you wish to run the program.
  13.  
  14. Version 2.4: some bugs fixed, INCLUDE files accepted, EQUIVALENCE
  15. statement processing, allow blanks in numeric constants.  NOTE: the
  16. format of project files has been changed.  They are not compatible
  17. with project files created by Version 2.3.
  18.  
  19. Version 2.3: a few more bugs fixed, and several syntax extensions added,
  20. notably DO WHILE.  Project files added.
  21.  
  22. Version 2.2: two reported bugs in V.2.1 were fixed, and some features
  23. were added.  See forchek.doc for details.
  24.  
  25. The file is shipped in the form of a "sh archive" or "shar" file.  You
  26. should first concatenate all parts in order (if it was sent in
  27. pieces), removing any mail headers.  Next, if you have a UNIX system,
  28. simply feed it as input to the program "sh" to unpack it
  29. automatically.  If you do not have a UNIX system, you will have to use
  30. your text editor to clip out each file manually.  You will observe
  31. that each line of every file has been prefixed with the letter X, and
  32. all tabs have been converted to the grave accent (ASCII code 60
  33. hexadecimal).  This was done to prevent clobbering during shipment
  34. across network gateways.  You should use your editor to remove all
  35. initial X's and to change all grave accents to tabs.
  36.  
  37. After accomplishing this step, you should find that you have received
  38. the following set of source files:
  39.  
  40.         forchek.c       intrins.h       symtab.h
  41.         forchek.h       iokeywds.h      symtab2.c
  42.         forlex.c        prsymtab.c      tokdefs.h
  43.         fortran.c       symtab.c
  44.  
  45. You should also have received the following auxiliary files:
  46.  
  47.         average.f     build.com     makefile.tc
  48.         average.out   makefile
  49.  
  50. Documentation is in the files:
  51.  
  52.         forchek.doc   forchek.hlp   forchek.man   forchek.ps
  53.  
  54. The first is a flat text file.  Forchek.hlp is for making a help
  55. library for VMS systems.  Forchek.man and forchek.ps are provided for
  56. the convenience of those with access to nroff/troff or PostScript,
  57. respectively.
  58.  
  59.  
  60. VAX/VMS users should rename "AVERAGE.F" to "AVERAGE.FOR".
  61. Once Forchek is working, you can test it by giving the command:
  62.  
  63.         $ forchek -list -sym average
  64.  
  65. Then compare the output against the file "average.out".  (Trailing
  66. blanks have been removed from average.out due to shipping the Forchek
  67. package across network gateways.)
  68.  
  69. To install Forchek, follow the instructions below for your operating
  70. system.
  71.  
  72.  
  73. (1) Unix
  74.  
  75.    Give the command:
  76.  
  77.         $ make
  78.  
  79.  
  80.  
  81. (2) VAX/VMS
  82.  
  83.    Give the command
  84.  
  85.         $ @BUILD
  86.  
  87.    After the program has been compiled, you must turn it into a
  88.    so-called "DCL foreign command" so that it can be invoked by
  89.    giving its name on a command line, instead of using the RUN
  90.    command.  Do this with the command
  91.  
  92.         $ FORCHEK :== $disk:[directory]FORCHEK
  93.  
  94.    where you substitute the disk and directory names where the file
  95.    FORCHEK.EXE resides.  This command must be executed once per
  96.    login.
  97.  
  98.  
  99.  
  100. (3) MS-DOS with Turbo C
  101.  
  102.    Rename the file "makefile.tc" to "makefile" and then give the
  103.    command:
  104.  
  105.         C> MAKE
  106.  
  107.  
  108.  
  109. (4) Other systems
  110.  
  111.    It should suffice simply to compile all the ".c" files and link
  112.    them.  The only differences among the versions for different
  113.    operating systems have to do with the use of "/" vs. "-" as an
  114.    option prefix, and the default filename extension ".FOR" vs. ".f".
  115.    Selection among these options is done by defining a macro name for
  116.    each system.  The VAX/VMS compiler pre-defines the macro name
  117.    "VMS", while the Turbo C compiler pre-defines "__TURBOC__".
  118.    Compilation without defining either of these macro names is the
  119.    same as compiling with "UNIX" defined.
  120.  
  121.    To allow "/" as an option prefix, you can define the macro name
  122.    "VMS", either as a commandline option to the compiler, or by
  123.    altering the file forchek.h: just remove the commenting-out of
  124.    the appropriate #define command found there.  In any case, "-" is
  125.    always allowed as an option prefix.
  126.  
  127.    The default extension ".FOR" is assumed for VMS or Turbo C, ".f"
  128.    for all others, unless you define the macro name
  129.    "DEF_SRC_EXTENSION" otherwise on the compiler commandline or in
  130.    forchek.h.  Other default values of Forchek's built-in parameters
  131.    can be similarly modified on the compiler commandline.  See
  132.    forchek.h for details.
  133.  
  134.  
  135.  
  136.  
  137.